“selector”是一个简单的Redux库,灵感来源于
NuclearJS
.
- Selector可以计算衍生的数据,可以让Redux做到存储尽可能少的state。
- Selector比较高效,只有在某个参数发生变化的时候才发生计算过程.
- Selector是可以组合的,他们可以作为输入,传递到其他的selector.
1 | //这个例子不必太在意,后面会有详细的介绍 |
Table of Contents
- Installation
- 实例
- API
-
- Why isn’t my selector recomputing when the input state changes?
- Why is my selector recomputing when the input state stays the same?
- Can I use Reselect without Redux?
- The default memoization function is no good, can I use a different one?
- How do I test a selector?
- How do I create a selector that takes an argument?
- How do I use Reselect with Immutable.js?
- Can I share a selector across multiple components?
- Are there TypeScript typings?
- How can I make a curried selector?
- License
安装
npm install reselect
实例
缓存Selcectos的动机
实例是基于 Redux Todos List example.
containers/VisibleTodoList.js
1 | import { connect } from 'react-redux' |
在上面的例子中,mapStateToProps
调用getVisibleTodos
去计算todos
.这个函数设计的是相当好的,但是有个缺点:todos
在每一次组件更新的时候都会重新计算.如果state树的结构比较大,或者计算比较昂贵,每一次组件更新的时候都进行计算的话,将会导致性能问题.Reselect
能够帮助redux避免不必要的计算过程.
创建一个缓存Selector
我们可以使用记忆缓存selector代替getVisibleTodos
,如果state.todos
和state.visibilityFilter
发生变化,他会重新计算state
,但是只发生在其他部分的state变化,就不会重新计算.
Reslect提供一个函数createSelector
来创建一个记忆selectors.createSelector
接受input-selectors
和一个变换函数作为参数.如果Redux的state发生改变造成input-selector
的值发生改变,selector会调用变换函数,依据input-selector
做参数,返回一个结果.如果input-selector
返回的结果和前面的一样,那么就会直接返回有关state,会省略变换函数的调用.
下面我们定义一个记忆selectorgetVisibleTodos
替代非记忆的版本
selectors/index.js
1 | import { createSelector } from 'reselect' |
上面的的实例中,getVisibilityfilter
和getTodos
是input-selectors.这两个函数是普通的非记忆selector函数,因为他们没有变换他们select的数据.getVisibleTodos
另一方面是一个记忆selector.他接收getVisibilityfilter
和getTodos
作为input-selectors,并且作为一个变换函数计算筛选的todo list.
组合selectors
一个记忆性selector本身也可以作为另一个记忆性selector的input-selector.这里getVisibleTodos
可以作为input-selector作为关键字筛选的input-selector:
1 | const getKeyword = (state) => state.keyword |
把Selector连接到Redux Store
如果你正在使用 React Redux, 你可以 直接在mapStateToProps()
中调用 selector:
containers/VisibleTodoList.js
1 | import { connect } from 'react-redux' |
在Selectors中获取 React 的 props
这一部分我们假设程序将会有一个扩展,我们允许selector支持多重todo List.请注意如果要完全实施这个扩展,reducers,components,actions等等都需要作出改变.这些内容和主题不是太相关,所以这里就省略掉了.
目前为止,我们仅仅看到selectors接收store的state作为一个参数,其实一个selector叶可以接受props.
这里是一个App
组件,渲染出三个VisibleTodoList
组件,每一个组件有ListId
属性.
components/App.js
1 | import React from 'react' |
每一个VisibleTodoList
container应该根据各自的listId
属性获取state的不同部分.所以我们修改一下getVisibilityFilter
和getTodos
,便于接受一个属性参数
selectors/todoSelectors.js
1 | import { createSelector } from 'reselect' |
props
可以从mapStateToProps
传递到getVisibleTodos
:
1 | const mapStateToProps = (state, props) => { |
现在getVisibleTodos
可以获取props
,每一部分似乎都工作的不错.
**但是还有个问题!
当getVisibleTodos
selector和VisibleTodoList
container的多个实例一起工作的时候,记忆功能就不能正常运行:
containers/VisibleTodoList.js
1 | import { connect } from 'react-redux' |
使用createSelector
创建的selector时候,如果他的参数集合和上一次的参数机会是一样的,仅仅返回缓存的值.如果我们交替渲染<VisibleTodoList listId="1" />
和<VisibleTodoList listId="2" />
时,共享的selector将会交替接受{listId:1}
和{listId:2}
作为他的props的参数.这将会导致每一次调用的时候的参数都不同,因此selector每次都会重新来计算而不是返回缓存的值.下一部分我们将会介绍怎么解决这个问题.
跨越多个组件使用selectors共享props
这一部分的实例需要React Redux v4.3.0或者更高版本的支持.
在多个VisibleTodoList
组件中共享selector,同时还要保持记忆性,每一个组件的实例需要他们自己的selector私有拷贝.
现在让我们创建一个函数makeGetVisibleTodos
,这个函数每次调用的时候返回一个新的getVisibleTodos
的拷贝:
selectors/todoSelectors.js
1 | import { createSelector } from 'reselect' |
我们也需要设置给每一个组件的实例他们各自获取私有的selector方法.mapStateToProps
的connect
函数可以帮助完成这个功能.
如果mapStateToProps
提供给connect
的不是一个对形象,而是一个函数,每个container
中就会创建独立的mapStateToProps
实例.
在下面的实例中,mapStateProps
创建一个新的getVisibleTodos
selector,他返回一个mapStateToProps
函数,这个函数能够接入新的selector.
1 | const makeMapStateToProps = () => { |
如果我们把makeMapStateToprops
传递到connect
,每一个visibleTodoList
container将会获得各自的含有私有getVisibleTodos
selector的mapStateToProps
函数.这样一来记忆就正常了,不管VisibleTodoList
containers的渲染顺序怎么样.
containers/VisibleTodoList.js
1 | import { connect } from 'react-redux' |
API
createSelector(…inputSelectors|[inputSelectors],resultFunc)
接受一个或者多个selectors,或者一个selectors数组,计算他们的值并且作为参数传递给resultFunc
.
createSelector
通过判断input-selector之前调用和之后调用的返回值的全等于(===,这个地方英文文献叫reference equality,引用等于,这个单词是本质,中文没有翻译出来).经过createSelector
创建的selector应该是immutable(不变的).
经过createSelector
创建的Selectors有一个缓存,大小是1.这意味着当一个input-selector变化的时候,他们总是会重新计算state,因为Selector仅仅存储每一个input-selector前一个值.
1 | const mySelector = createSelector( |
在selector内部获取一个组件的props非常有用.当一个selector通过connect
函数连接到一个组件上,组件的属性作为第二个参数传递给selector:
1 | const abSelector = (state, props) => state.a * props.b |
defaultMemoize(func, equalityCheck = defaultEqualityCheck)
defaultMemoize
能记住通过func传递的参数.这是createSelector
使用的记忆函数.
defaultMemoize
通过调用equalityCheck
函数来决定一个参数是否已经发生改变.因为defaultMemoize
设计出来就是和immutable数据一起使用,默认的equalityCheck
使用引用全等于来判断变化:
1 | function defaultEqualityCheck(currentVal, previousVal) { |
defaultMemoize
和createSelectorCreator
去配置equalityCheck
函数.
createSelectorCreator(memoize,…memoizeOptions)
createSelectorCreator
用来配置定制版本的createSelector
.
memoize
参数是一个有记忆功能的函数,来代替defaultMemoize
.…memoizeOption
展开的参数是0或者更多的配置选项,这些参数传递给memoizeFunc
.selectorsresultFunc
作为第一个参数传递给memoize
,memoizeOptions
作为第二个参数:
1 | const customSelectorCreator = createSelectorCreator( |
在customSelecotr
内部滴啊用memoize的函数的代码如下:
1 | customMemoize(resultFunc, option1, option2, option3) |
下面是几个可能会用到的createSelectorCreator
的实例:
为defaultMemoize
配置equalityCheck
1 | import { createSelectorCreator, defaultMemoize } from 'reselect' |
使用loadsh的memoize函数来缓存未绑定的缓存.
1 | import { createSelectorCreator } from 'reselect' |
createStructuredSelector({inputSelectors}, selectorCreator = createSelector)
如果在普通的模式下使用createStructuredSelector
函数可以提升便利性.传递到connect
的selector装饰者(这是js设计模式的概念,可以参考相关的书籍)接受他的input-selectors,并且在一个对象内映射到一个键上.
1 | const mySelectorA = state => state.a |
createStructuredSelector
接受一个对象,这个对象的属性是input-selectors,函数返回一个结构性的selector.这个结构性的selector返回一个对象,对象的键和inputSelectors
的参数是相同的,但是使用selectors代替了其中的值.
1 | const mySelectorA = state => state.a |
结构性的selectors可以是嵌套式的:
1 | const nestedSelector = createStructuredSelector({ |
FAQ
Q:为什么当输入的state发生改变的时候,selector不重新计算?
A:检查一下你的记忆韩式是不是和你的state更新函数相兼容(例如:如果你正在使用Redux).例如:使用createSelector
创建的selector总是创建一个新的对象,原来期待的是更新一个已经存在的对象.createSelector
使用(===)检测输入是否改变,因此如果改变一个已经存在的对象没有触发selector重新计算的原因是改变一个对象的时候没有触发相关的检测.提示:如果你正在使用Redux,改变一个state对象的错误可能有.
下面的实例定义了一个selector可以决定数组的第一个todo项目是不是已经被完成:
1 | const isFirstTodoCompleteSelector = createSelector( |
下面的state更新函数和isFirstTodoCompleteSelector
将不会正常工作工作:
1 | export default function todos(state = initialState, action) { |
下面的state更新函数和isFirstTodoComplete
一起可以正常工作.
1 | export default function todos(state = initialState, action) { |
如果你没有使用Redux,但是有使用mutable数据的需求,你可以使用createSelectorCreator
代替默认的记忆函数,并且使用不同的等值检测函数.请参看这里 和 这里作为参考.
Q:为什么input state没有改变的时候,selector还是会重新计算?
A: 检查一下你的记忆函数和你你的state更新函数是不是兼容(如果是使用Redux的时候,看看reducer).例如:使用每一次更新的时候,不管值是不是发生改变,createSelector
创建的selector总是会收到一个新的对象.createSelector
函数使用(===
)检测input的变化,由此可知如果每次都返回一个新对象,表示selector总是在每次更新的时候重新计算.
1 | import { REMOVE_OLD } from '../constants/ActionTypes' |
下面的selector在每一次REMOVE_OLD调用的时候,都会重新计算,因为Array.filter总是返回一个新对象.但是在大多数情况下,REMOVE_OLD action都不会改变todo列表,所以重新计算是不必要的.
1 | import { createSelector } from 'reselect' |
你可以通过state更新函数返回一个新对象来减少不必要的重计算操作,这个对象执行深度等值检测,只有深度不相同的时候才返回新对象.
1 | import { REMOVE_OLD } from '../constants/ActionTypes' |
替代的方法是,在selector中使用深度检测方法替代默认的equalityCheck
函数:
1 | import { createSelectorCreator, defaultMemoize } from 'reselect' |
检查equalityCheck
函数的更替或者在state更新函数中做深度检测并不总是比重计算的花销小.如果每次重计算的花销总是比较小,可能的原因是Reselect没有通过connect
函数传递mapStateProps
单纯对象的原因.
Q:没有Redux的情况下可以使用Reselect吗?
A:可以.Reselect没有其他任何的依赖包,因此尽管他设计的和Redux比较搭配,但是独立使用也是可以的.目前的版本在传统的Flux APP下使用是比较成功的.
如果你使用
createSelector
创建的selectors,需要确保他的参数是immutable的.
看这里
Q:怎么才能创建一个接收参数的selector.
A:Reselect没有支持创建接收参数的selectors,但是这里有一些实现类似函数功能的建议.
如果参数不是动态的,你可以使用工厂函数:
1 | const expensiveItemSelectorFactory = minValue => { |
总的达成共识看这里和超越 neclear-js是:如果一个selector需要动态的参数,那么参数应该是store中的state.如果你决定好了在应用中使用动态参数,像下面这样返回一个记忆函数是比较合适的:
1 | import { createSelector } from 'reselect' |
Q:默认的记忆函数不太好,我能用个其他的吗?
A: 我认为这个记忆韩式工作的还可以,但是如果你需要一个其他的韩式也是可以的.
可以看看这个例子
Q:怎么才能测试一个selector?
A:对于一个给定的input,一个selector总是产出相同的结果.基于这个原因,做单元测试是非常简单的.
1 | const selector = createSelector( |
在state更新函数调用的时候同时检测selector的记忆函数的功能也是非常有用的(例如 使用Redux的时候检查reducer).每一个selector都有一个recomputations
方法返回重新计算的次数:
1 | suite('selector', () => { |
另外,selectors保留了最后一个函数调用结果的引用,这个引用作为.resultFunc
.如果你已经聚合了其他的selectors,这个函数引用可以帮助你测试每一个selector,不需要从state中解耦测试.
例如如果你的selectors集合像下面这样:
selectors.js
1 | export const firstSelector = createSelector( ... ) |
单元测试就像下面这样:test/selectors.js
1 | // tests for the first three selectors... |
最后,每一个selector有一个resetRecomputations
方法,重置recomputations方法为0,这个参数的意图是在面对复杂的selector的时候,需要很多独立的测试,你不需要管理复杂的手工计算,或者为每一个测试创建”傻瓜”selector.
Q:Reselect怎么和Immutble.js一起使用?
A:creatSelector
创建的Selectors应该可以和Immutable.js数据结构一起完美的工作.
如果你的selector正在重计算,并且你认为state没有发生变化,一定要确保知道哪一个Immutable.js更新方法,这个方法只要一更新总是返回新对象.哪一个方法只有集合实际发生变化的时候才返回新对象.
1 | import Immutable from 'immutable' |
如果一个操作导致的selector更新总是返回一个新对象,可能会发生不必要的重计算.看这里.这是一个关于pros的讨论,使用深全等于来检测例如immutable.js
来减少不必要的重计算过程.
Q:可以在多个组件之间共享selector吗?
A: 使用createSelector
创建的Selector的缓存的大小只有1.这个设定使得多个组件的实例之间的参数不同,跨组件共享selector变得不合适.这里也有几种办法来解决这个问题:
- 使用工程函数方法,为每一个组件实例创建一个新的selector.这里有一个内建的工厂方法,React Redux v4.3或者更高版本可以使用. 看这里
- 创建一个缓存尺寸大于1的定制selector.
Q:有TypeScript的类型吗?
A: 是的!他们包含在package.json
里.可以很好的工作.
Q:怎么构建一个柯里化selector?
A:尝试一些这里助手函数,由MattSPalmer提供
有关的项目
reselect-map
因为Reselect不可能保证缓存你所有的需求,在做非常昂贵的计算的时候,这个方法比较有用.查看一下reselect-maps readme
reselect-map的优化措施仅仅使用在一些小的案例中,如果你不确定是不是需要他,就不要使用它.
License
MIT